REST API: Convert empty properties arrays to objects for valid JSON schema #8608
Conversation
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
himanshupathak95
force-pushed
the
fix/63186-empty-properties-json-schema
branch
from
9308318 to
b7fad5c
Compare
felixarntz
left a comment
felixarntz
left a comment
There was a problem hiding this comment.
@himanshupathak95 Thank you for the PR!
The sanitizer function looks great. I think there's one problem to figure out though regarding when to call it.
himanshupathak95
force-pushed
the
fix/63186-empty-properties-json-schema
branch
from
b7fad5c to
d4af322
Compare
himanshupathak95
force-pushed
the
fix/63186-empty-properties-json-schema
branch
2 times, most recently
from
3b5b3b2 to
bb75e9a
Compare
…to handle additional parameters
…o an object in schema
…changed in schema
…ies field is not affected
… request handling
…te logic into WP_REST_Server
himanshupathak95
force-pushed
the
fix/63186-empty-properties-json-schema
branch
from
bb75e9a to
f57bee4
Compare
3 participants
Trac ticket: https://core.trac.wordpress.org/ticket/63186
This PR addresses the issue where empty
propertiesarrays in REST API JSON schemas are output as[]instead of{}.According to JSON Schema specifications, the
propertiesfield must always be an object. However, when a REST API schema in PHP uses'properties' => array(), it gets JSON-encoded as"properties": [], which is an invalid JSON schema.This PR adds a sanitization function that recursively processes REST API schema data and converts any empty
propertiesarrays to empty objects (usingstdClass), ensuring valid JSON schema output. The fix is minimal and targeted, applied via a filter at the appropriate stage of REST API response processing.